Infraction notification webhook (MED)
info
📘 To learn more about webhooks in our API, follow the link below:
When a Notification infraction is created, the best way to receive this information is by using the `INFRACTION_NOTIFICATION_CREATED``webhook.
Here is the simplest way to set up a INFRACTION_NOTIFICATION_CREATED
webhook:
Headers
Name | Description |
---|---|
x-delbank-api-key | Required. API key |
Body
{
"eventType": "INFRACTION_NOTIFICATION_CREATED",
"url": "https://example.com.br/webhooks/v1/infractionNotification", // Add your own URL here
"authorization": "NONE,
"authorizationScheme": "NONE"
}
Once an Infraction notification has been created, here is what you will receive at the registered URL:
{
"id": "00287f1e-aa85-452c-9ca6-d08d810c571c",
"endToEndId": "E38224857202501201735276EqueqSVM",
"reason": "RETURN_REQUEST",
"status": "PENDING",
"debitedParticipant": {
"ispb": "21018182",
"name": "BOLETOBANCÁRIO.COM TECNOLOGIA DE PAGAMENTOS LTDA."
},
"creditedParticipant": {
"ispb": "38224857",
"name": "DELBANK"
},
"infractionDetails": "01",
"analysisDetails": null,
"createdAt": "2022-04-07T10:25:32.793Z",
"updatedAt": "2025-02-13T16:35:13.907Z"
}
Here are the attributes that are passed by the INFRACTION_NOTIFICATION_CREATED
webhook:
Name | Type | Description |
---|---|---|
id | string | Infraction notification ID |
endToEndId | string | endToEndId of the transaction related to the infraction notification |
reason | enum | Infraction notification reason, Domains: FRAUD ,Refund request: RETURN_REQUEST ,Refund cancellation: RETURN_CANCELLATION |
details | string | Details about the type of infraction |
status | enum | PENDING , CANCELED , ACCEPTED , REJECTED |
debitedParticipant | object | Object containing information about the institution where the infraction notification was debited |
debitedParticipant.isbp | string | ISPB of the institution |
debitedParticipant.name | string | Name of the institution |
creditedParticipant | object | Object containing information about the institution where the infraction notification was credited |
creditedParticipant.isbp | string | ISPB of the institution |
creditedParticipant.name | string | Name of the institution |
analysisDetails | string | Details about the analysis of the infraction notification |
createdAt | date | Creation date |
updatedAt | date | Update date |